home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / prog_bas / vbres.zip / README.TXT < prev    next >
Text File  |  1996-04-09  |  8KB  |  237 lines
  1. ---------------------------------------------------------------
  2.                    VB-Res (Freeware Version)
  3. ---------------------------------------------------------------
  4.                  Copyright ⌐ 1996 Gregg Irwin
  5.                      All Rights Reserved.
  6. ---------------------------------------------------------------
  7.  
  8. This software is FREEWARE. You may use it as you see fit for 
  9. your own projects but you may not re-sell the original or a 
  10. derivative. If you redistribute it you must include this 
  11. disclaimer and all original copyright notices. 
  12.  
  13. No warranty is inferred or implied, as always seems to be the
  14. case with software these days. Use at your own risk. Keep away
  15. from small children. Don't exceed recommended dosage. I'm not
  16. liable, I'm not liable, I'm not liable.
  17.  
  18. A commercial or shareware version may be forthcoming but that 
  19. will depend on how much value people see in a tool like this.
  20. i.e. is it worth the effort to add all the features a commercial
  21. version should have?
  22.  
  23. I haven't intentionally crippled the freeware version in any 
  24. way. If you think a critical feature is missing it's just 
  25. because I didn't have, or couldn't justify, the time to put it 
  26. in. Of course I may not have thought about it either.<g>
  27.  
  28. Things like resource memory load options and a floating File
  29. Browser would be nice to have, I agree, but they don't impede
  30. the general usefulness of VB-Res.
  31.  
  32. If you have any suggestions on how to improve VB-Res, or if 
  33. you find bugs, I would be more than happy to hear about them.
  34.  
  35. -- Gregg Irwin [72450,676]
  36.  
  37.  
  38. ---------------------------------------------------------------
  39. What is VB-Res?
  40. ---------------------------------------------------------------
  41. VB-Res is a resource compiler. It creates RES files for use 
  42. with your VB projects. It was written entirely in VB, using 
  43. no VBXs or OCXs. It can create both 16 and 32-bit RES files 
  44. from either the 16 or 32-bit version of VB-Res. It's a Windows 
  45. program so you no longer have to run RC.EXE from a command 
  46. window.
  47.  
  48. It doesn't support Dialog, Menu, or Accelerator resources
  49. because they can't be used from VB. It does support Bitmap,
  50. Icon, Cursor, StringTable, and custom resources.
  51.  
  52. VB-Res will require all the runtimes that any VB EXE requires.
  53. They are not included, and there is no setup program. This 
  54. means you have to have VB4 installed on your system in order
  55. to use VB-Res. Why? Because it's freeware, designed for use 
  56. *with* VB, and corners had to be cut somewhere. 
  57.  
  58. ---------------------------------------------------------------
  59. How it works, basically
  60. ---------------------------------------------------------------
  61. 1) Create a new project.
  62. 2) Add resources (ICO, BMP, etc.). 
  63. 3) Save your project.
  64. 4) Compile your project.
  65.  
  66. Voila! 
  67.  
  68. ---------------------------------------------------------------
  69. Creating a New Project / Project Options
  70. ---------------------------------------------------------------
  71. Select File|New. Pretty tough, eh?
  72.  
  73. At this point you have an empty, nameless project. 
  74. Not very useful.
  75.  
  76. When you save the project the first time, VB-Res 
  77. will use the filename as a default "Name" for the
  78. project. The project Name is not linked to the file
  79. name so you can put anything you want in the Name
  80. field under Project|Options. The Name is what will be 
  81. used in the title bar of the project window.
  82.  
  83. You can also add a description for the project that
  84. will be shown at the bottom of the project window. You
  85. might use this as a note field as well.
  86.  
  87. The 16 and 32 bit RES file names are the target files
  88. that will be generated by the compiler. Default names
  89. are set when you save the file the first time (or if
  90. you delete the names at some point).
  91.  
  92.  
  93. ---------------------------------------------------------------
  94. Adding Resources to Projects
  95. ---------------------------------------------------------------
  96. You can:
  97.  
  98. a) Select File|Add File, which will give you a common
  99.    dialog.
  100.  
  101. b) Drag and drop files from the File Browser onto a 
  102.    project.
  103.  
  104. c) Double click a file in the File Browser
  105.  
  106. d) Select a file in the File Browser and hit <Enter>
  107.  
  108. e) Drag and drop a file from another project
  109.  
  110. When you add a resource to a Project it is assigned
  111. a default resource ID. You can change the resource ID
  112. to be a different number or a string. 
  113.  
  114. To do this, first select the resource in the list, 
  115. then right-click on the list. Select Properties from 
  116. the popup menu and change the ID to whatever you want. 
  117.  
  118. If the first three items in the popup menu are disabled 
  119. it means that no item is selected in the list. 
  120.  
  121. You can't change the memory options for the resource at 
  122. this time. They will always be disabled in the freeware 
  123. version.
  124.  
  125.  
  126. ---------------------------------------------------------------
  127. Editing Resources
  128. ---------------------------------------------------------------
  129. The first thing to do is configure VB-Res to use the editor(s)
  130. you want. Use the Options/Editors menu item to do this. Then...
  131.  
  132. To edit a resource:
  133.  
  134. a) Select a resource, right-click, and select Edit from the 
  135.    context menu.
  136.  
  137. - or -
  138.  
  139. b) Double click a resource in the list.
  140.  
  141. Editors are launched with the resource file name as a command
  142. line parameter. Your editor must support this method in order
  143. to be used with VB-Res. Any decent editor should do this.
  144.  
  145.  
  146. ---------------------------------------------------------------
  147. Project Files
  148. ---------------------------------------------------------------
  149. .VBR files are project files. It's basically a MAK/VBP file
  150. for a VBRes project.
  151.  
  152.  
  153. ---------------------------------------------------------------
  154. String Tables
  155. ---------------------------------------------------------------
  156. .STB files are stringtable files. The format is:
  157.  
  158. <ID> = <String>
  159.  
  160. One string per line.
  161.  
  162. Example:
  163. '-------------------------
  164. '-- VB-Res StringTables
  165. '-------------------------
  166. &H1    = VB-Res
  167. &H2    = Freeware Version 
  168. &H3    = Copyright ⌐ 1996 by Gregg Irwin
  169.  
  170.  
  171. ID *must* be a number, no names allowed. You can use Hex 
  172. notation, if you want, by prefixing the number with "&H".
  173.  
  174. No quotes around strings.
  175.  
  176. Strings are Trim'd when compiled.
  177.  
  178. Expressions (e.g. 1 + 2 ) are not supported for ID's.
  179.  
  180. Comments in STB files can start with a semicolon or 
  181. single quote (; or ').
  182.  
  183. If the file extension for the stringtable file is *not*
  184. .STB then the first line in the file must be a header
  185. line indicating that it's an STB file. The header is:
  186.  
  187. VBRES_STB_100
  188.  
  189.  
  190. ---------------------------------------------------------------
  191. Credits
  192. ---------------------------------------------------------------
  193.  
  194. Thanks to the brave beta testers who risked life and limb in 
  195. the pursuit of easier RES file creation.
  196.  
  197. Dan Barclay
  198. Eric Brierley
  199. Michiel de Bruijn
  200. Craig Clearman
  201. Paul Clement
  202. Jim Deutch
  203. Dick Grier
  204. L.J. Johnson
  205. Ibrahim Malluf
  206. Doug Marquardt
  207. David McCarter
  208. Enis Moran
  209. Gary Nelson
  210. Karl Peterson
  211. Pete Roberts
  212. Ron Schwarz
  213. (I Hope I didn't forget anyone!)
  214.  
  215. Extra thanks to Craig Clearman who provided some valuable 
  216. snippets of code to help with long filename support.
  217.  
  218. Extra special thanks to Karl Peterson who was the original
  219. guinea pig long, long ago when I first got the wild idea to 
  220. write a resource compiler with pure VB code.
  221.  
  222. Thanks Guys!
  223.  
  224. --Gregg
  225.  
  226.  
  227. ---------------------------------------------------------------
  228. Version History
  229. ---------------------------------------------------------------
  230.  
  231.  
  232. Version 1.00   April 9, 1996
  233. ---------------------------------------------------------------
  234.  
  235. * Initial release
  236.  
  237.